/*
===========================================================================
This source file is part of DyLab (Dynamic Laboratory)
For the latest info, see http://dylab.googlecode.com

Copyright (c) 2006-2008 Lukas Krejci
(krejci.lukas@volny.cz)

This file is part of DyLab.

    DyLab is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    DyLab is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with DyLab.  If not, see <http://www.gnu.org/licenses/>.
===========================================================================
*/

#ifndef __dylab_HapticsEvent_h__
#define __dylab_HapticsEvent_h__

//===========================================================================================
#include <dylab/utils/String.h>

//===========================================================================================
namespace dylab {

    /** 
     *
     */
    class DYLAB_EXPORT HapticsEvent
    {
    public:
        // all possible event types
        enum type_t 
        {
            BUTTON_DOWN,
            BUTTON_UP
        };

        // button ids
        enum button_t 
        {
            BUTTON_0,
            BUTTON_1
        };

    private:
        // input event type
        type_t mType;

        // when the event occured
        uint32_t mTimeStamp;

        // button id
        button_t mButton;

    public:

        /** button event
         */
        HapticsEvent(type_t _type, uint32_t _timeStamp, button_t _button);

        /**
        */
        virtual ~HapticsEvent();

        /**
        */
        type_t getType() const;

        /**
        */
        uint32_t getTimeStamp() const;

        /**
        */
        button_t getButton() const;
    };
}

//===========================================================================================
#endif // __dylab_HapticsEvent_h__
